package com.lv.jie.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * Swagger注解	简单说明
 * Api(tags = "xxx模块说明")	作用在模块类上
 * ApiOperation("xxx接口说明") 作用在接口方法上
 * ApiModel("xxxPOJO说明") 作用在模型类上：如VO、BO
 * ApiModelProperty(value = "xxx属性说明",hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
 * ApiParam("xxx参数说明") 作用在参数、方法和字段上，类似@ApiModelProperty
 *
 *  http://localhost:8080/swagger-ui.html访问接口
 * @author dell
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 配置docket以配置Swagger具体参数
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 配置分组
                .groupName("index")
                //配置是否启用Swagger，如果是false，在浏览器将无法访问
                .enable(true)
                // 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lv.jie.controller"))
                // 配置如何通过path过滤,即这里只扫描请求以/column开头的接口
                //.paths(PathSelectors.ant("/column/**"))
                .build();
    }

    /**
     * 配置文档信息
     */
    private ApiInfo apiInfo() {
        Contact contact = new Contact("OrangeHash", "https://gitee.com/orangehash", "orange-hash@qq.com");
        return new ApiInfo(
                // 标题
                "index",
                // 描述
                "index",
                // 版本
                "v1.0",
                // 组织链接
                null,
                // 联系人信息
                contact,
                // 许可
                "Apache 2.0 许可",
                // 许可连接
                "https://www.apache.org/licenses/LICENSE-2.0.html",
                // 扩展
                new ArrayList<>()
        );
    }
}
